home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 029a / sclip.zip / SCLDOC.FW3 (.txt) < prev    next >
FrameworkDocument  |  1990-07-23  |  81KB  |  1,425 lines

  1. scldoc
  2. Scan & Clip<return>Instructions
  3. July 10, 1990
  4. <page>
  5.     Scan & Clip (version 1.00) is a Fred program that scans most
  6. types of frames for words that you choose, clips those "hits"
  7. (along with an 
  8. adjustable
  9.  context block of surrounding lines) to
  10. another report frame, thus, producing a report that consists only
  11. of the parts of the original document in which you are
  12. interested.
  13.     Scan & Clip is intended to be a document (or program)
  14. analysis
  15.  tool, not merely a text retrieval program.
  16.     Originally, this program was designed as a legal practice
  17. tool; to scan large deposition text files received from the court
  18. reporter on disk as ASCII files, that are simply loaded on the
  19. desktop and scanned without modification. Sub-versions of each
  20. deposition can be produced on different aspects of the case. The
  21. program now has been expanded to cover a wide variety of frame
  22. types.
  23.     I also use Scan & Clip to analyze long FRED formulas. It
  24. helps me debug and tighten up, say to bring together every time I
  25. use a particular variable, with cross references to the original
  26. formula line where each hit can be found in the original.
  27.     The primary types of Framework Frames can be scanned. Most
  28. varieties of nested outline frames can be searched; on formulas,
  29. labels, and text !
  30.     Batch operation options allow several separate documents to
  31. be searched in one batch (e.g. search all the depositions in a
  32. particular case in one batch). The batch mode can search frames
  33. on the desktop or load them from disk, one at a time (Thus, the
  34. total, aggregate frame size that can be scanned in a batch can
  35. exceed available desktop RAM).
  36.     Scan & Clip is text oriented. But modules for spreadsheets
  37. and databases are included. 
  38. ;{F9} to read
  39. Short Description
  40. Installation
  41. AUTO INSTALL -
  42.  If you already have not done so, you can
  43. automatically install the macros and program by loading the file
  44. named "SCLins.fw3" to the desktop, placing the cursor on the
  45. frame, and recalculating it by pressing {F5}. You will be
  46. instructed and prompted from there for a safe, fast install. 
  47. *** Install ends with some very basic instructions for a quick
  48. trial run. Note: all that is installed in your Library is a
  49. small 
  50. invoking
  51.  macro (SCLaltm.fw3), which when invoked, in turn,
  52. brings the real program (SCLprg.fw3) to the desktop, if it is
  53. not already on the desktop. (see below).
  54. THE FIRST TIME
  55.  that SCLaltm (renamed {Alt-S}) is invoked it,
  56. in turn, installs SCLprg in your Library (without deleting
  57. SCLALTM or renaming either module) . See Sections 3.2.1 below
  58.     See Special Topics - Screen Display, if you do not like the
  59. display that appears on your monitor.  
  60. or.  
  61. ur monit
  62. ;{F9} to read
  63. Automatic
  64. MANUAL INSTALL -
  65.     1. Copy all SCL prefix files (e.g. SCL*.*) to your FW3
  66. default drive and directory. 
  67.  the included macro (
  68. SCLaltm
  69. into your Library
  70. SCLaltm is the macro that is called by an ALT-KEY combination.
  71. Rename SCLaltm to the {Alt-key} combination that you desire (I
  72. use {Alt-S} -- the auto install program stores SCLaltm in your
  73. Library as {Alt-S} and renames any pre-existing {Alt-S} as "old
  74. alt-s"). SCLaltm calls (or installs and calls see Section 3.1
  75. below) the real program, SCLprg.fw3, which is about 64K.
  76.     3. A. 
  77. THE FIRST TIME
  78.  that SCLaltm is invoked (i.e. by
  79. pressing {Alt-s} it, in turn, installs SCLprg in your Library
  80. and (without deleting SCLALTM or renaming either module) passes
  81. control to SCLprg, until SCLprg is manually deleted from your
  82. Library. 
  83.        B. This procedure: [1] Avoids permanently burdening your
  84. Library and Ram with a large program that you probably will use
  85. in concentrated periods, rather than randomly; but [2] Leaves
  86. the main program on the desktop after it is initially invoked
  87. (thus, avoiding the delay of loading a 64K program for each
  88. document scan).
  89.        C. When a session is completed, manually delete SCLprg
  90. from your Library 
  91.  simply do not save your Library when you
  92. quit (unless you want it to continue to reside there). BUT LEAVE
  93. SCLALTm (which, by then, would have been renamed to an {alt-key}
  94. combination). 
  95.  RAM is not a concern, you may want to leave
  96. SCLprg permanently in your Library when you save it.
  97.        D. SCLALTM installs SCLprg in your Library, rather than
  98. on the desktop, in order to avoid some very complicated path
  99. names that would be necessary. SCLprg will NOT run from your
  100. desktop, except IN your Library.
  101.     4. See Special Topics - Screen Display, if you do not like
  102. the display that appears on your monitor. 
  103. Manual
  104. Operating Instructions
  105. The program should be invoked by a macro
  106. , preferably, the
  107. included macro; e.g. {Alt-S}. The suggested macro is included as
  108. SCLALTM (to be renamed as a ALT KEY combination, such as
  109. {Alt-S}). See Section on Installation. 
  110.     To scan and clip a document, SCLprg (to be renamed) is
  111. expected to be stored in your Library, but it need NOT be stored
  112. there when {alt-s} is pressed. 
  113. If it is not stored in your Library (to conserve Ram), the
  114. SCLaltm (renamed) will load it into your Library for that
  115. session.
  116.     SCLaltm ALWAYS should reside in your Library.
  117. ;{F9} to read
  118. Invoking the program with the included macro
  119. Using the program
  120.      You initiate Scan & Clip by pressing an Alt key
  121. combination.  You can set the Alt key combination to any one you
  122. wish, but, for convenience, 
  123. this documentation will assume that
  124. you have chosen {Alt-S}.  All references to {Alt-S} in this
  125. documentation will refer to the particular Alt key combination
  126. that you choose.  
  127.     When you press {Alt-S} one of two things will happen.  
  128.     If you have stored the main program (SCLPRG) in your
  129. Library
  130. , then pressing {Alt-S} will immediately run the program
  131. and present you with the Scan & Clip menu (see below).  
  132.     If, however, for whatever reason, including conservation of
  133. Library
  134.  space, you have chosen not to keep the main program in
  135. your Library
  136. , then pressing {Alt-S}, at any time when SCLPRG is
  137. not resident in your Library, will load SCLPRG from your hard
  138. disk and install SCLPRG in your Library
  139. . Once installed, SCLPRG
  140. will remain in your Library until you manually delete it or do
  141. not save Library
  142.  at the end of session.
  143.      If the main program (SCLPRG) is not in the Library
  144.  when you
  145. press {Alt-S}, then the program will not run on that pressing,
  146. but will respond with a message to the effect that the program
  147. has been installed in your Library.  Then (once the main program
  148. has been temporarily installed in your Library), the next time
  149. you press {Alt-S} the program will run.  
  150.     See Section 2.2 for the reason for this routine, which,
  151. primarily, is to allow a particular user not to dedicate the 64K
  152. required by SCLPRG to the storage of this program in RAM when it
  153. is not in use.
  154. Pressing {Alt-key} to start
  155.      In order to properly run, the cursor MUST be properly placed
  156. when you press {Alt-S}. 
  157. The required placement of the cursor
  158. varies depending on the type of frame being searched and the type
  159. of search
  160. .  The proper cursor placements are:  
  161.      (1) a word, text frame, spreadsheet, or database, 
  162. contained in an outline or containing frame
  163. : Cursor 
  164. can be inside the document or on the frame label. NOTE: SEARCH
  165. DATABASES in "table view", i.e. row/column;  
  166.     (2)  Formulas, 
  167. not in outline or containing frame:
  168. formula must be zoomed so that it fills the whole screen and the
  169. cursor should be at the {ctrl-home} position of the zoomed
  170. formula;
  171.     (3)  Outlines of 
  172.  type: Cursor must be on the frame label
  173. of the outer most containing frame;
  174.     (4)  Batched, desktop:  Cursor should be on the first (i.e. 
  175. top) frame. No frame should reside (graphically) below the last
  176. frame in the batch;
  177.     (5)  Batched, disk:  Cursor should be in the open file disk
  178. cabinet with the cursor placed on the first (i.e. top) frame to
  179. be batched, loaded and scanned. No frame should reside
  180. (graphically) below the last frame in the batch.
  181. batch.
  182. Required cursor placement 
  183. before
  184.  pressing 
  185. {Alt-Key}. 
  186. VERY IMPORTANT.
  187. sor pla,
  188.      If you press {Alt-S} after SCLPRG is installed in the
  189. Library (see above), you immediately will be presented with a
  190. three choice menu on the prompt line. The three choices are:
  191. [S]can, [C]hange or view Setup, or [Q]uit.
  192.     To change or view the current defaults for the next document
  193. to be scanned,  press "C" or cursor to the "Change or view Setup"
  194. option and press {return}.   Then, you will be presented with the
  195. Set-up menu.  See Section 4 below.
  196.      To scan a document and generate a report, press "S" or
  197. choose the "Scan" menu choice with your cursor and press
  198. {return}.
  199. First menu choice, to scan or set or view options
  200. Changing or viewing options
  201.     When you press {alt-s} (assuming that it has been
  202. initialized, see Section 3.2.1), you are presented in the prompt
  203. line with a menu choice of: Scan, Change or view Setup, or Quit.
  204. If the situation in which you invoked {alt-s} permits (see
  205. Section 4.4.6), along with this initial menu, the currently
  206. effective settings for 
  207.  of the key program variables/options
  208. are displayed, so that you can more conveniently determine
  209. whether you need to change the Setup settings.
  210.     To change the Setup settings "on the fly" for scanning that
  211. and all subsequent documents (until reset), choose "Change or
  212. view Setup". You then will be presented with a 
  213. full screen
  214.  menu.
  215.     This Change or view Setup sub-menu is mirrored in Section
  216. 4.4 of this documentation (to which you should refer). Several of
  217. the first level choices, in turn, lead to additional sub-menus.
  218.     To select (and change or merely view) a particular setting
  219. or menu choice, use the arrow keys to place cursor on it and,
  220. then, press {return} (if, 
  221. and only if
  222. , the menu choices begin
  223. with a unique first letter, as they do on the first level, a menu
  224. choice also can be chosen by pressing the first character of the
  225. menu choice in question).
  226.     If the particular menu choice, in turn, contains nested menu
  227. choices, then pressing {return} will bring up the next level
  228. menu. If the particular menu choice is, itself, a default
  229. variable setting choice, then when, you press {return}, you will
  230. be presented with a data entry prompt.
  231.     In the latter situation, the prompt line will contain the
  232. "permanent" default for that particular setting and the prompt
  233. line message will show the "current" setting. (See Section 4.2
  234. for an explanation of the quoted terms). You can press {return}
  235. to accept the "permanent" setting or you can enter any valid
  236. entry for that particular variable.
  237.     Choose Quit, when finished. The entered changes will remain
  238. "current" until changed. The "permanent" setting will not be
  239. affected. (See Section 4.3.2 for instructions on how to change
  240. "permanent" settings).
  241. ings).
  242. On the fly, for a particular document
  243.     See Section 4.
  244.     To reset to the "permanent" defaults, choose "All reset"
  245. from the "Change or view Setup" menu.
  246.  menu.
  247. Resetting to defaults
  248. Scanning
  249.      After you choose to scan, then you will be presented with 
  250. one, two, or three additional prompts (depending on optional
  251. settings).  
  252.     You will be presented with the first prompt in all cases
  253. (search criteria), you will be presented with the second prompt
  254. (size of context block), only if you have this option toggled for
  255. this prompt.  See Section 4.4.2.1 below.  
  256.     If you are scanning an outline (containing) frame you will
  257. be presented with the third prompt (identify what in the outline
  258. to search), only if you have this option toggled for this
  259. prompt.  See Section 4.4.5.1 below.  
  260.      After you enter an appropriate response to the prompt, the
  261. program will proceed automatically from there and will
  262. periodically report its progress.
  263.      
  264. If you batch scan a group of documents, either from the
  265. desktop or from disk, then the input at the first two prompts
  266. will be applied to each document in the batch.
  267.  That is, you
  268. cannot batch scan documents for different search terms or with
  269. different context blocks. However, you 
  270.  batch scan different
  271. outline types (by requiring a prompt to indicate type, for each
  272. document in the batch).
  273. Library
  274. Overview
  275.     At the first prompt, enter the search criteria. The search
  276. criteria can be any valid Framework search phrase, including wild
  277. cards. 
  278. For further information on valid Framework criteria, see
  279. pages C2 & C3 of "Using" FW3 documentation and the files called
  280. DBSRCH.ART AND WILDCD.ART in Lib. 10 CIS Ashforum.
  281. For example, enter "Smok*" (without the quotes) to search
  282. for all words with the root "smok".
  283.     The {ctrl-l} menu choices can be set before a scan, to
  284. further refine a search. E.g. "Ignore Capitalization", off or on.
  285. or on.
  286. Entering search term
  287.     If the second prompt is toggled on (prompt for context
  288. size), enter an Arabic number.  The number chosen will be the 
  289. number of lines above and below the hit which will be captured 
  290. in the generated report along with a hit, to give the hit
  291. context.  
  292.     The number can be as low as zero and as large as the page
  293. size.  As a practical matter, 2 to 8 is recommended. As explained
  294. in the Special Topics Section 6.9 below, in some circumstances a
  295. context block of zero (0) can cause a problem. 
  296.     If you are searching a frame that is double-spaced 
  297. on the
  298. screen
  299.  (it is not relevant how it is spaced on the printed
  300. document) you must remember to double the context block you
  301. intend.  For example, choosing a context block of one in a double
  302. spaced document (on the screen) will clip the hit line only,
  303. because one line above and below the hit line will be empty.
  304. Entering size of context block
  305. General
  306.      Scan & Clip offers you the option to batch scan several
  307. files and documents that reside on your hard disk or desktop. 
  308. The disk batch option is especially useful if the several files
  309. that you desire to batch scan would, in the aggregate, be too
  310. large for the available RAM on your desktop.  
  311.     NOTE: The formula area can be batch scanned 
  312.  as part of
  313. and contained in an outline. Individual, separate frames can not
  314. be scanned for their formulas, in the batch mode.
  315.      In the Setup menu, there is an option to toggle batch scan
  316. on and off. A separate option in the same Setup sub-menu lets you
  317. choose to batch scan from the desktop or hard or floppy disk.
  318. Batch Scans From Disk
  319.  The disk batch option loads designated files from your
  320. designated disk, one at a time, scans them, creates a report of
  321. clips (hits), and deletes from the desktop (not from the disk)
  322. the scanned original document before loading the next document to
  323. be scanned.
  324.      You can scan from any available drive. The cabinet for the
  325. disk must be open and contain only the files to be batch scanned,
  326. by filtering the cabinet (or by storing the target frames in a
  327. unique sub-directory).
  328.      To begin the batch scan, when {Alt-S} is pressed, the cursor
  329.  be on the top frame (i.e. on the first of the files to be
  330. batch scanned). There should be no frame located (graphically)
  331. below the last frame in the batch. With the cursor so placed and
  332. with the proper batch settings in the Setup menu, simply press
  333. {ALT-S} and each file will be loaded to the desktop and
  334. scanned.  
  335.     NOTE:  Because you must instruct the program on 
  336.  it is
  337. inside an outline frame that you wish to scan (formula, label or
  338. text), as each file in a particular batch is addressed for
  339. scanning, 
  340. either
  341.  you must answer this prompt for each outline
  342. that is, in turn, addressed for scanning, 
  343.  you must use the
  344. Setup option in the Setup outline sub-menu to toggle off this
  345. type of outline scan prompt so that the program skips this prompt
  346. and selects, by default, 
  347.  in the outline is to be scanned. 
  348. If you choose this toggle (i.e. turn off this prompt), then you
  349. must, again by menu choice in the Setup outline sub-menu, set,
  350. for all the frames to be batch scanned, what in the outline frame
  351. you wish to be batch scanned.  If you choose this option, then
  352. only outline attributes of the same type can be successfully
  353. batched. I.e., if this toggle is chosen, you cannot batch scan
  354. three different attributes of outlines, one for labels, one for
  355. formula and one for text.  If  you want to do this (i.e. mix
  356. attributes), leave the prompt toggle on and, as each frame is
  357. loaded to the desktop to be batch scanned, be prepared to answer
  358. this prompt. See Section 4.4.5.
  359. , before
  360. Batch scans
  361.  : To avoid needless repetition, some important 
  362. usage
  363. tips and information on advanced features are contained in
  364. Section 4, in describing the program options. Thus, the Setup
  365. Section 4 should be read as an instructional aid, even if you do
  366. not intend to change any of the original default settings.
  367. Advanced features
  368. t.n.j.V.
  369. Setup : Changing program parameters
  370.      Of the 26 options in running Scan and Clip that can be set
  371. from the Setup menu, each option has a setting with three
  372. "permanency"  characteristics; "original", "permanent", and
  373. "current".
  374.     Probably, you will want to study this Setup section of the
  375. documentation after you read Section 3.2 (Using the program) and
  376. have made a few trial runs. The Setup options will be more
  377. meaningful after you have used the program.
  378.     There are several variables that are desirable, indeed
  379. necessary, to adjust for the characteristics of a particular
  380. task. On the other hand, for each user these variables will 
  381. to remain constant, once originally set; as an example, the
  382. number of lines per ASCII page that his or her particular court
  383. reporter uses as a standard for a deposition page. Thus, it would
  384. become burdensome to prompt for each of these variables each time
  385. a document is scanned.
  386.     As a solution, the SCLprg outline contains a sub-frame
  387. called "Setup", in which these several variables are nested. Each
  388. can be changed and will remain applicable for future uses, until
  389. again changed.
  390.     The Setup variables, which are user set, are to be
  391. distinguished from the global variables shown in the SCLprg  
  392. outline frame, which global variables are program set. Scan &
  393. Clip uses both.
  394.     Each of the Setup variables is described in this section.
  395. The description of these variables contains several usage tips
  396. and operational information that is not repeated elsewhere.
  397. ;{F9} to read
  398. About the setup options
  399.     As mentioned above, each program option has three
  400. "permanency" characteristics.
  401.     First, for each program option default, the program as
  402. originally up-loaded contains an original setting that I set.
  403. These are referred to as "the original defaults". If changed, you
  404. can refer to this documentation if you desire to return to the
  405. original default.
  406.      Second, for each option, there also is a "permanent" default
  407. which is the default that is set in the spreadsheet frame called 
  408. "Setup Defaults", under the "Setup Modules" subsection of
  409. SCLprg.fw3.  It is nested below, but on an equal level with, the
  410. sub-frame called "Setup Menu".  If a "permanent" default is
  411. changed (see Section 4.3.2 below), and if SCLPRG is saved after a
  412. change of a "permanent" default, then the new entry will become
  413. the new "permanent" default. It (the new change) will be
  414. "permanent" until otherwise directly changed in the Setup
  415. Defaults spreadsheet frame (See Section 4.3.2).
  416.     Third, for each option, there also is a "current" default
  417. which is the default that is set for each variable contained in
  418. the containing (menu) outline frame called "Setup Menu", under
  419. the "Setup Modules" subsection of SCLprg.fw3. The "current"
  420. default can be different from the "permanent" default. 
  421. "current" default is the setting that actually is used in program
  422. processing
  423. . It is changed "on the fly" as explained below.
  424.     Thus, for each program option, there are two active
  425. defaults, with the "current" being the controlling setting for a
  426. particular scan and with the "permanent" default preserved for
  427. easy resetting after a particular scan.
  428.      The "current" default is the setting for each option that
  429. will be processed the next time that Scan & Clip is run.  These
  430. can be saved from session to session and need not (but can) be
  431. reset from document to document. So, in that sense they are 
  432. "permanent."  However, if the spreadsheet frame that contains the
  433. permanent options is recalculated, 
  434. or you choose the All reset
  435. option from the setup menu, then all the current defaults will be
  436. reset back to the permanent default
  437.     This structure should provide you with the greatest document
  438. to document and session to session flexibility, while still
  439. providing a quick way back to your particular generally preferred
  440. settings.
  441.      As you read the description of the three types of defaults 
  442. and use them in actual practice, I think that you will see that 
  443. the three levels of "permanency" give the user considerable 
  444. flexibility in using the program with the minimum need to 
  445. customize each of the 26 options document-by-document, but with 
  446. the flexibility to do so when appropriate.
  447.      For example, 90% of your documents might be run with 
  448. mark-hit "on" and you would want your permanent default to be on.
  449. However, on a particular day, you might have to process 6 
  450. documents with mark-hit "off".  Rather than change the permanent 
  451. default, in that situation you would want to change the mark-hit 
  452. default from the setup menu and make "off" (N) the current 
  453. default which will stay active until either changed from the
  454. menu, or "All reset" is chosen to return to the "permanent"
  455. default ("on", in this example).
  456. Current vs. Permanent vs. Original Defaults
  457. Changing Defaults
  458. Current
  459.      To set a new current default without changing the permanent 
  460. default, press {Alt-S} and, at the first menu prompt, choose
  461. "Change or view Setup".  You then will be presented with a
  462. sub-menu that will have all of the Setup menu options sub-grouped
  463. by categories (which correspond, in structure and organization to
  464. Section 4.4 of this documentation). Choose the appropriate
  465. category and press return.  You then will be presented with a
  466. sub-menu for all of the options within that sub-category. Place
  467. the cursor on the particular option you want to change and press
  468. {return}.  
  469.     The prompt data entry line will show the permanent default
  470. and the prompt line will show the current default.  Thus, when
  471. you choose an option from within the Setup menu you will see both
  472. active possibilities ("current" and "permanent").  
  473. Of course, you
  474. may choose to set a valid setting other than either default (as
  475. long as the entry is valid for that particular option).
  476.     Whatever you enter will become the "current default". It
  477. will replace the old "current" default. The permanent default
  478. will not be affected.
  479.      NOTE:  There are options that allow you to enter narrative
  480. text, such as the contents of report notes. These entries may be
  481. several lines.  Obviously, all will not appear in the prompt
  482. line.  To enter a new multi-line setting for one of these 
  483. options, simply select the appropriate menu choice (see above),
  484. zoom the edit line with {f9}, and enter and format as you wish.
  485. When completed, zoom back to the single prompt line and then
  486. press {return} to set the new current default.
  487. cter, scr
  488. Setting new current parameter
  489.      If you make several changes to the current defaults, 
  490. inevitably, you will want to get back to your normal options that
  491. apply to most of your documents.  To do so quickly, simply choose
  492. the "All Reset" option from the setup menu and press {return}. 
  493. Doing so will return the "current" defaults for all options to
  494. their respective "permanent" defaults.
  495. Re-setting to permanent settings
  496.      To change a "permanent" default, 
  497. you do NOT use the Scan &
  498. Clip menu. Instead, 
  499. manually
  500.  navigate to the spreadsheet frame in
  501. SCLprg.fw3 called "Setup Defaults", under the "Setup Modules"
  502. subsection of SCLprg.fw3.  It is nested below, but on an equal
  503. level with, the sub-frame called "Setup Menu".
  504. Press {f9} to zoom 
  505.  the spreadsheet called "Setup Defaults".
  506. Press {ctrl-home}, if not in the first cell.
  507.     Inside you will see three columns.  The far left hand column
  508. contains an alias name for each of the options; the alias name
  509. corresponds to the actual option name except that the alias name
  510. begins with a "d", to differentiate it from the actual frame that
  511. contains the currently active setting for each option.  For
  512. example, the frame that contains the currently active setting for
  513. the toggle that controls whether to mark hits is called MHX and
  514. its alias in the permanent setup frame is called "dMHX".  
  515.     The second column contains the corresponding permanent
  516. default.   Again, for example, the original default (which will
  517. be the first permanent default) for MHX is "Y, i.e. ON). 
  518. change a "permanent" default, you manually change the entry in
  519. this column.
  520.     The third column contains a simple guide to the possible
  521. valid entries for each default option.
  522.      There also is a fourth column that is hidden by sizing. This
  523. hidden column contains the formula, that when recalculated,
  524. resets the current active default back to the permanent default. 
  525.     When the "All Reset" option is chosen from the setup menu,
  526. all current defaults are reset to the permanent defaults
  527. contained in column two of this spreadsheet, see above.
  528. If you change a permanent default (by changing the entry in
  529. the second column of the Setup Defaults spreadsheet frame), you
  530. must save sclprg.fw3 to really make the change permanent
  531. . If you
  532. keep sclprg in your Library, simply save your Library. If you do
  533. not, but install it only as needed (see Section 2.2), then you
  534. will need to copy the current copy of sclprg that contains the
  535. changes (which probably will be 
  536.  in your Library) to the
  537. desktop and save it to overwrite the sclprg.fw3 that is on your
  538. hard drive.
  539. Permanent
  540. @menu(Setup Menu)
  541. The Setup menu
  542. L.6.&.
  543. Report parameters
  544. H.D.@.
  545. Footnotes
  546.     The program allows two footnotes to be placed in the report.
  547. One in the title and one in the legend that indicates the end of
  548. the report. You can toggle on/off each or both or any one of
  549. these. 
  550. PX1 toggles on/off the note that appears in the heading
  551. title. PX2 toggles on/off the note that appears after the end of
  552. report marker.
  553.     Of course, after a report is generated, you can move or
  554. delete the program generated notes or add additional notes, by
  555. using the FW3 footnote features. The two program generated
  556. footnotes, reflect 
  557. perceived "standard".
  558. The placement of the notes can be changed and additional
  559. standard notes can be added by code modifications to the "Report"
  560. module, under the "common modules" section of SCLprg.fw3.
  561.     The original default for PX1 is "Y" (without the quotes).
  562.     Change as explained in Section 4.3, above.  
  563. PX1 ; toggle report note #1
  564. on(Y)/off(N)
  565.     This contains the text of footnote one that will be inserted
  566. if PX1 is toggled on. By "zooming" the edit line, it can be made
  567. multiple lines and the Word menu can be used to format it, as is
  568. done with the original default, which is :
  569. This report is confidential.
  570.                               
  571.                 "
  572. [formatted differently than appears above].
  573.     Change as explained in Section 4.3, above.  
  574. PN1 ; contents of report note #1
  575.     The program allows two footnotes to be placed. One in the
  576. title and one in the legend that indicates the end of the report.
  577. You can toggle on/off each or both or any one of these. 
  578. preceeding section on PX1.
  579.     The original default for PX2 is "Y" (without the quotes).
  580.     Change as explained in Section 4.3, above.  
  581. footno
  582. PX2 ; toggle report note #2
  583. on(Y)/off(N)
  584.     This contains the text of footnote two that will be inserted
  585. if PX2 is toggled on. By "zooming" the edit line, it can be made
  586. multiple lines and the Word menu can be used to format it, as is
  587. done with the original default, which is :
  588. Page cross references in this
  589. report are calculated. When a
  590. document is printed, page
  591. breaks are affected by many
  592. factors. The page cross
  593. references in this report may
  594. not correspond to the page
  595. numbers of your particular
  596. hard copy, either because the
  597. calculation parameters were
  598. improperly set or because of
  599. the printing characteristics
  600. of your document.
  601.                 "
  602. [formatted differently than appears above].
  603.     Change as explained in Section 4.3, above.  
  604. PN2 ; contents of report note #2
  605. Document page description
  606.     As elsewhere explained, the generated report, cross
  607. references each hit to the FW3 frame line AND a hard copy page
  608. number. For actual use, especially by someone who did not
  609. generate the report, the 
  610. description
  611.  of the hard copy is
  612. important. A generic reference might be confusing.
  613.     For example, in my reports of depositions, I prefer to cross
  614. reference to "deposition page 120", rather than "hard copy page
  615. 120". In a particular situation, you might even want to get more
  616. specific, such as "Jones Report page 12". [Note: the ASCII frame
  617. name for a deposition usually is the deponent's name, so the
  618. cross reference to "deposition page" communicates, because the
  619. report title includes the source frame name].
  620.     This reference is set by two setup variables; PR1 for text
  621. frames and PR2 for database, spreadsheet, and formula frames. I
  622. assumed that a particular user might have different "standards"
  623. for each of these categories. For example, being a lawyer, I set
  624. PR1 to "deposition page" (without the quotes) and PR2 to "hard
  625. copy page" (without the quotes) . 
  626.     For both PR1 & PR2 the original default is "hard copy page"
  627. (without the quotes).
  628.     Change as explained in Section 4.3, above.  
  629. PR1 ; description source
  630. hard copy for page cross
  631. reference in report for
  632. text frames
  633. n sourc
  634.     See PR1, in the immediately preceding section.
  635.     For both PR1 & PR2 the original default is "hard copy page"
  636. (without the quotes).
  637.     Change as explained in Section 4.3, above.  
  638. PR2 ; description source
  639. hard copy for page cross
  640. reference in report for
  641. other frame types
  642. Margin & printing attributes
  643.     As elsewhere explained, the generated report is presented on
  644. screen after the scan is complete, ready for printing. Because it
  645. is anticipated that SCLprg will be used on frames imported from
  646. other software or ASCII conversions (like depositions), there is
  647. no way really to know on what the margin settings for each line
  648. will be. For example, an ASCII deposition imports with a right
  649. margin of 255, which really messes up centering of the Scan &
  650. Clip generated report title. 
  651.     Therefor, before presenting the report to you on screen, the
  652. program re-formats the right and left margin of the report. 
  653.     The setting for each is dictated by ML and MR, respectively.
  654.     For lack of better means to guess your particular main use,
  655. the original default for ML is "0" (without the quotes) and the
  656. original default for MR is "80" (without the quotes).
  657.     Change as explained in Section 4.3, above.
  658. ML; left margin width
  659.     See ML in the immediately preceding section.
  660.     For lack of better means to guess your particular main use,
  661. the original default for ML is "0" (without the quotes) and the
  662. original default for MR is "80" (without the quotes).
  663.     Change as explained in Section 4.3, above. 
  664. MR; right margin width
  665.     As elsewhere explained, the generated report is formatted
  666. for printing after the scan is complete, to make it ready for
  667. printing. Because it is anticipated that SCLprg will be used on
  668. frames imported from other software or ASCII conversions (like
  669. depositions), there is no way really to know on what the printing
  670. width settings for each line will be, in relation to the screen
  671. margin settings that you choose.
  672.     Therefor, before presenting the report to you on screen, the
  673. program sets three printing format characteristics: a centered
  674. footer for <page>, which I hope is non-controversial and
  675. universally desired; and the offset and line width, which can be
  676. changed by changing the setup variables ( 
  677. OF course, before
  678. printing the report, you can 
  679.  manually
  680.  change ALL printing
  681. variables from the FW3 Print menu
  682.     The setting for each is dictated by PO and PW, respectively.
  683.     For lack of better means to guess your particular main use,
  684. the original default for PO is "0" (without the quotes) and the
  685. original default for PW is "80" (without the quotes).
  686.     Change as explained in Section 4.3, above.
  687. PO; printing offset
  688.     See PO, in the immediately preceding section.
  689.     For lack of better means to guess your particular main use,
  690. the original default for PO is "0" (without the quotes) and the
  691. original default for PW is "80" (without the quotes).
  692.     Change as explained in Section 4.3, above.
  693. PW; printing width
  694.      When searching a document that is loaded on the Framework 
  695. desktop after it has been converted from another format, you may 
  696. import into the new (converted) document the ASCII new page codes
  697. that are sent to the printer to make it eject a page.  That is,
  698. ASCII characters 012 may appear in the document 
  699. and Scan & Clip
  700. report
  701.  (if it appears within the context block of a hit).  
  702.      If so, when you try to print out the generated report, the 
  703. ASCII character 012 will be sent to the printer and cause an 
  704. undesired new page and page eject.
  705.      For a document without these codes or in a rough-cut
  706. situation, the program execution time needed to remove these
  707. codes is unnecessary and you might not particularly care whether
  708. the page codes are imbedded or not.  However, if you desire to
  709. print the document and circulate it, you probably will want to
  710. eliminate any ASCII 012 codes. 
  711.     This option, DPCX, is a toggle for deleting these ASCII 012
  712. codes, 
  713. from the generated report, NOT from your source frame.
  714. save you from the time necessary to manually delete the codes, if
  715. you are going to process all or several of your documents that
  716. would contain such codes, you probably will want to toggle this
  717. option on.  If toggled on, the program will automatically remove
  718. all ASCII 012 codes from the generated report(s). 
  719.     The original default for DPCX is "N" (without the quotes);
  720. i.e. "off" ASCII page codes will not be removed.
  721.     Change as explained in Section 4.3, above.
  722. rogram
  723. DPCX ; toggle delete ASCII page codes 
  724. from report, on(Y)/off(N)
  725. PCX ; 
  726. 2~2z2
  727. cription
  728. Hit marks
  729.     Unless this option is toggled off the Scan & Clip report
  730. that is generated highlights the "hit" criteria each time that it
  731. appears in the report (your original source frame is not
  732. changed). For example, if searched on "Tom", each time "Tom"
  733. appears in the report, it will be highlighted. For some people,
  734. this makes reading the report much easier.
  735.     On the other hand, the highlighting process requires
  736. significant processing time; only just about one order of
  737. magnitude less than the rest of the program! You may want to gain
  738. speed at the price of eliminating this feature, especially if the
  739. highlighting does not contribute to your purposes. (See Section
  740. 4.4.1.4.2, for a compromise alternative to either on or off).
  741.     Highlighting can be toggled off by changing MH to any text
  742. character other than a "Y". Of course, using a "N" will help you
  743. remember.
  744.     To toggle back on, change MH to a "Y" (without the quotes).
  745.     The original default is "Y"; i.e. highlighting on.
  746.     Change as explained in Section 4.3, above.
  747. MHX ; toggle whether to highlight hits
  748. in report, on(Y)/off(N)
  749. MHX ; t
  750.     This toggle chooses between two alternative methods by which
  751. the program marks hits in your report. One ([R]egular) makes a
  752. better presentation. The other ([Q]uick) is much faster, but the
  753. presentation is not polished.
  754.     Regular is chosen by setting this option to "R" (without the
  755. quotes). Quick is chosen by setting this option to "Q" (without
  756. the quotes).
  757.     Regular locates each occurrence of a hit that is contained
  758. in the report and highlights each individual hit in the report
  759. with the chosen hitmark. It highlights the complete word that
  760. contains the matching character(s). However, this marking process
  761. takes 75% or so of the same processing time for the clipping part
  762. of the program. For a report with numerous hits, it can be
  763. significant.
  764.     Quick simply replaces all occurrences of hits in a report
  765. with the search term reformatted to match the chosen hitmark.
  766. Rather than a loop that loops a number of times equal to the
  767. number of hits, Quick is a one step process. It is much faster
  768. than Regular, but the generated report is not as clean.
  769.     Although the two methods may sound the same, they produce
  770. different results. 
  771.     First, when Quick replaces, it is literal. This is best
  772. illustrated by an example: If you search on "smok*", it will hit
  773. on "...caused by smoking..." and the report will so read; but
  774. when the hit is marked by the 
  775. Quick
  776.  method it will be changed to
  777. read "...caused by 
  778. smok*
  779. ing..." (assuming that the hitmark is
  780. bold). In the same example, marking by the 
  781. Regular
  782.  method will
  783. read "...caused by 
  784. smoking
  785. ...". 
  786.     Second, 
  787. and this is important to know
  788. , Quick formats the
  789. hitmark from the Replace ({ctrl-l}R) edit line. This means that
  790. the hitmark is limited to the one letter formatting choices
  791. available on the edit line, being [B]old, [U]nderline, [I]talic,
  792. [S]trike Through, [L]owered subscript, and [R]aised superscript.
  793. The Regular marking methods formats from the document, which adds
  794. [A]ll Caps, [I]nitial Caps, and [N]o Caps, as additional possible
  795. hit marks. As another consequence, the choice between Quick and
  796. Regular also affects the entry for "HITMARK" (next section) that
  797. is necessary to effect a particular format. E.g. to select Raised
  798. superscript, HITMARK must be set to "R", if Quick is on, but to
  799. "WR", if Regular is on.
  800.     The original default is "R"; i.e. Regular highlighting
  801. method.
  802.     Change as explained in Section 4.3, above. 
  803. MHO ; [R]egular marking method or
  804. [Q]uick mark
  805.     If MHX is on (Y), as explained above, the "hits" are
  806. highlighted 
  807. in the report
  808. . The source document is not
  809. highlighted. The original default method of highlighting is by
  810. BOLDING
  811.  each hit.
  812.     The method of highlighting can be changed to be any text
  813. option that can be set from the FW3 Words menu. The setup
  814. sub-frame called HITMARK must contain the letters necessary to
  815. choose the intended highlighting feature AFTER {ctrl-W}. (see
  816. below and previous section if MHO is set to [Q]uick).
  817.     For example, "B" (without the quotes), to set for bold. Some
  818. other examples are as follows:
  819. Underline : U
  820. Italic : I
  821. All Caps : WA
  822. Superscript : WR
  823. Subscript : WL
  824.     The choice between Quick and Regular marking methods also
  825. affects the entry for "HITMARK" that is necessary to effect a
  826. particular format. E.g. to select Raised superscript, HITMARK
  827. must be set to "R", if Quick is on, but to "WR", if Regular is
  828. on. See previous Section.
  829.     The original default is "B"; i.e. highlight by bolding.
  830.     Change as explained in Section 4.3, above. 
  831. HITMARK ; method of highlighting hits
  832. Context block parameters
  833.     The Scan & Clip report that is generated includes the "hit"
  834. criteria 
  835.  a block of lines above and below each "hit", to
  836. give the "hit" context. 
  837.     How many lines above and below a "hit" that is predictably
  838. necessary to give context will vary between documents. E.g. one
  839. line above and below a database "hit" probably will be enough (as
  840. it will capture three complete records), but five or more lines
  841. might be advisable in narrative word documents (especially if
  842. double spaced on the screen). Because the size of the ideal block
  843. will vary, the original setting for this option prompts for the
  844. block size.
  845.     On the other hand, a particular user may tend normally to
  846. use this program on one variety of documents, for which the ideal
  847. context block is the same. After becoming familiar with the
  848. operation of this program such a user will find the blocksize
  849. prompt to be unnecessary and tedious.
  850.     Prompting for the size of the context block can be toggled
  851. off by changing BSPX (which stands for block size prompt) to any
  852. text character other than a "Y". Of course, using a "N" will help
  853. you remember.
  854.     To toggle back on, change BSPX a "Y" (without the quotes).
  855.     The original default is "Y"; i.e. prompt on.
  856.     Change as explained in Section 4.3, above.
  857. BSPX ; toggle user set block size by prompt,
  858. on(Y)/off(N)
  859.     As explained in the previous section, the Scan & Clip report
  860. that is generated includes the "hit" criteria 
  861.  a block of
  862. lines above and below each "hit", to give the "hit" context. 
  863.     IF prompting for the size of the context block is toggled
  864. OFF as explained in the previous section, THEN the context block
  865. size will be controlled by the value set for the setup variable
  866. "BSPn".
  867.     The original default is "6" (without the quotes); i.e. For
  868. each "hit", 13 lines will be clipped, the line in which the hit
  869. occurs and 6 lines below and above the line of the hit.
  870.     The size can be as low as 0 (zero).
  871.     The original default for BSPn is "6" (without the quotes).
  872.     Change as explained in Section 4.3, above.
  873. BSPn ; size of block default, if BSPX off(N)
  874.     The program "hits" and clips to the report frame every
  875. instance of hitting the search criteria. 
  876.     Because the report includes not only the frame line of the
  877. "hit", but also a context block below and above each "hit, the
  878. same "hit" can appear several times in a report.
  879.     For example :
  880.         Bob loves Sue
  881.         Sue Loves Bob
  882.         Tommy
  883.         Sue
  884. With context block size set to three, a search of "Sue" (assuming
  885. the above is single spaced on your screen) will show "Bob loves
  886. Sue" 3 times; once as a hit, once as part of the context block
  887. with a hit on "Sue loves Bob", and once again as part of the
  888. context block with a hit on the last line "Sue". 
  889.     Sometimes this repetition is desirable (it is, at least,
  890. doggedly thorough) and sometimes it is not.
  891.     When you want to eliminate reporting of subsequent "hits"
  892. within a chosen close proximity of a preceding "hit", set BPX to
  893. on (Y).
  894.     This will ignore a subsequent "hit" that occurs within a set
  895. number of lines after a particular "hit"; the number of lines
  896. being set by BPn (see next Section).
  897.     The original default for BPX is "N" (without the quotes).
  898.     Change as explained in Section 4.3, above.
  899. above.
  900. BPX ; toggle avoid close proximity hits,
  901. on(Y)/off(N)
  902.     If BPX is set on (Y), to eliminate close proximity "hits",
  903. then BPn is activated. The setting for BPn determines the line
  904. proximity in which subsequent hits will be ignored.
  905.     The setting may be less (or if you are daring, more) than
  906. the size of the context block. If BPX is on (Y), then the program
  907. will not separately hit on any search criteria that may appear
  908. BPn lines thereafter. (But the ignored data will appear as part
  909. of an earlier context block as long as the size of the context
  910. block equals or is larger than BPn)
  911.     E.g Context Block set at 4 and BPn set at 3 - search on
  912. "SUE" (assume the following appears single spaced on your
  913. screen):
  914. 1. Bob loves Sue
  915. 2. Sue goes to school
  916. 3. Tommy is a fireman
  917. 4. The teacher likes Sue
  918. 5. Mike's dog is black
  919. 6. Sue is pretty.
  920. Lines 1-5 will appear in the report on the "hit" of "Sue" in line
  921. 1. But "SUE" will not reappear as a hit on its own in lines 2 and
  922. 4. The next "hit" separately shown as a "hit" will be line 6,
  923. which will show lines 2-6 as part of its context block.
  924.     The original default for BPn is "2" (without the quotes).
  925.     Change as explained in Section 4.3, above.
  926. BPn ; size of close proximity range if BPX
  927. on(Y)
  928. Page parameters
  929.     As elsewhere explained, the generated report cross
  930. references each hit to the FW3 frame line AND a hard copy page
  931. number. Because it is anticipated that SCLprg will be used on
  932. frames of hardcopies that are the product of other software or
  933. ASCII conversions (like depositions) and an infinite combination
  934. of FW3 screen and print options, there is no way really to know
  935. on what original hardcopy page a particular hit will appear.
  936. (SEE ALSO, Special Topics heading "Page references").
  937.        
  938. LP is a setting that is crucial for accurate hard copy
  939. page reference calculations.
  940. To be accurate LP must be determined and reset (if necessary)
  941. for EACH Document that is scanned
  942.     To know how to set LP for your use, you must understand the
  943. method used to calculate the hard copy page numbers.
  944.     The program calculates the hard copy page with the following
  945. formulas:
  946. 1.        "
  947.           pp:=@business(@ceiling((@panel2+pf)/lpp),0),
  948.                                                       "
  949. 2. If the frame is an outline, "pf" is a running total of the
  950. total frame lines up to a particular "hit" in question,
  951. calculated, thusly:
  952.          "
  953. @if(IFT=5,@list(
  954.             @pk("{out}"),
  955.             @echo(#on,2),
  956.             @echo(#off),
  957.             @pk("{in}"),
  958.             pf:=TL-lpf, ; Tl-lpf, resulting in said determination
  959.             @pk("{in}{f9}")),
  960.                              "
  961. Otherwise, "pf" is 1.
  962. 3. "lpp" is the crucial variable, which is calculated by :
  963.      "                            
  964.        lpp:=@VALUE(LP), "
  965. "lpp" is "crucial", because it is set, by the user, outside of
  966. the program. The program senses or calculates the other
  967. variables. If "LP" is is wrongly set 
  968. for the particular document
  969. being scanned
  970. , the resulting page calculation will be wrong.
  971. Obtuse as that explanation is, the bottom line is that LP
  972. should be set to equal the number of frame 
  973. (i.e. screen)
  974.  lines
  975. per printed page of the source frame
  976. . Perhaps this is best
  977. illustrated by an example, again by reference to my main use,
  978. ASCII output of a deposition. 
  979.     In our area and with our firm's main court reporter service,
  980. ASCII output of a deposition is standardized as follows. Each
  981. printed page contains 25 
  982. numbered
  983.  lines of text, with an empty
  984. line in between (i.e. double spaced). Unlike some imports, the
  985. double spacing shows as such on the FW3 screen (so you count the
  986. blank line). Counting the top and bottom margins, when on my FW3
  987. desktop, as an ASCII file loaded without conversion or
  988. modification, each printed page of a deposition translates to 64
  989. FW3, on screen, 
  990. right panel
  991.  indicated, lines. For such a
  992. deposition, I set LP to "64" (without the quotes).
  993.     On the other hand, a DW4 
  994. double
  995.  spaced document that was
  996. converted to ASCII, then to Wordperfect, and finally then
  997. imported to FW3, appeared on my FW3 screen as 26 
  998. single
  999.  spaced
  1000. lines per printed page. Therefore, for that document (a long
  1001. contract), I set LP at 26.
  1002.     For lack of better means to guess your particular main use.
  1003. the original default for LP is "54" (without the quotes), which
  1004. is the correct number for a single spaced FW3 document, 
  1005. as I have
  1006. my printing defaults setup.
  1007. NOTE:
  1008.  An incorrect setting for LP is not as fatal as it may
  1009. sound. Even should the setting be incorrect and the generated
  1010. report cross-references be in error, the page cross-references
  1011. can be manually corrected in the generated report by using the
  1012. normal FW3 word processing features.
  1013.     Change as explained in Section 4.3, above.
  1014. LP  ; screen lines per page of hard copy
  1015. Batch operation options
  1016.     To facilitate project analysis, this program allows several
  1017. batch options. BATX toggles on(Y) and off(N), batch operation. If
  1018. it is off(N), the other batch choices are not relevant.
  1019.     To illustrate : Say you have 11 contracts that were part of
  1020. the closing of a particular deal. You wish to terminate the
  1021. relationship. You might want to batch scan all 11 contracts for
  1022. "<term*>". Another illustration : There are several depositions
  1023. in a case, you may wish to batch scan all of them for "<rain*>"
  1024. to get a comprehensive report on all the testimony about whether
  1025. it was raining.
  1026.     The original default for BATX is "N" (without the quotes).
  1027.     Change as explained in Section 4.3, above.
  1028. BATX ; toggle multi-frame batch operation
  1029. on(Y)/off(N)
  1030.     There are two basic types of batch operations; a particular
  1031. set of frames on the DESKTOP (FW) or a particular set of frames
  1032. on DISK (D) (hard or floppy). [tip - scanning sub-frames in an
  1033. outline also is a method of batch scanning; the only method for
  1034. batch scanning the formula area of frames.
  1035.     This option chooses which method to use ( See batch scan
  1036. instructions, Section 3.2.5.4).
  1037.     Desktop is faster. Disk is more practical if the total size
  1038. of the documents to be scanned exceeds your desktop RAM.
  1039.     The original default for BATT is "FW" (without the quotes),
  1040. for desktop.
  1041.     Change as explained in Section 4.3, above.
  1042. s; a parti
  1043. BATT ; set type of multi-frame batch if
  1044. on(Y), disk(D) or FW desktop(FW)
  1045. T ; !
  1046.     If you choose to batch scan (see above) you may also choose
  1047. to cause the reports to be automatically printed, without user
  1048. intervention.
  1049.     This option toggles that choice on(Y) or off(N). 
  1050. If on(Y), make sure that your printer is on and has plenty
  1051. of paper.
  1052.     The original default for BATP is "N" (without the quotes).
  1053.     Change as explained in Section 4.3, above.
  1054. alic : I
  1055. BATP ; toggle batch printing on(Y)/off(N)
  1056. Outline control
  1057.     As you know, one of the great features of FW3 is that an
  1058. outline can hold ANYTHING, words, database, spreadsheet, formula,
  1059. or only labels (not to mention graphs). A great feature, but a
  1060. pain for a scan program. 
  1061.     The method and behavior of searching (and even copying)
  1062. varies significantly from frame attribute to attribute. Thus, if
  1063. the program encounters an outline, it must be told WHAT (in the
  1064. outline) to search (i.e. searching labels, text-contents, or
  1065. formula?). (See below, the program can handle pretty complicated
  1066. outlines, as long as it knows whether to search the text-content,
  1067. the label, or the formula). 
  1068. NOTE: The contents of databases and spreadsheets contained in an
  1069. outline can 
  1070.  be scanned and clipped (to scan and clip these,
  1071. they must be non-contained, free-standing frames).
  1072.     This option toggles on(Y) or off(N) whether you BYPASS the
  1073. prompt for 
  1074.  to search, or whether the program "assumes" 
  1075. to search by default. BYPASS the prompt is ON., get the prompt is
  1076. OFF. If you almost always search an outline for the same type of
  1077. data, formula, for instance, you may want to avoid the prompt by
  1078. toggling OTX on (Y). 
  1079.     ALSO, if you batch scan several outlines of the same type,
  1080. you may want to toggle OTX on(Y), to avoid the necessity for
  1081. operator input for each document.
  1082.     The original default for OTX is "N" (without the quotes).
  1083.     Change as explained in Section 4.3, above.
  1084. ust be 
  1085. OTX ; toggle bypass prompt control of
  1086. outline type, on(Y)/off(N)
  1087. OTX ; tA
  1088.     If you choose to toggle OTX on(Y) and avoid the outline type
  1089. prompt, then OTT will control 
  1090. , in the outline, you are
  1091. searching.
  1092.     The possibilities are:
  1093.         [T]ext - meaning 
  1094. the word contents
  1095.  of a 
  1096.  frame. You
  1097. can not search database and spreadsheet contents, if contained in
  1098. an outline.
  1099.         [F]ormula - meaning the formula area of each contained
  1100. frame. E.g. I scanned all the sub-routines that make up SCLprg.
  1101.         [L]abels - I often use large outlines with nothing but
  1102. labels, in chronologies, for example. This choice will scan the
  1103. labels and the context block transcends levels and depends solely
  1104. on line proximity.
  1105.     For some applications, the scan of an outline can be used as
  1106. a batch process.
  1107.     The original default for OTT is "T" (without the quotes),
  1108. for text-contents.
  1109.     Change as explained in Section 4.3, above.
  1110. OTT ; set outline type to process, if OTX
  1111. on(Y): T/F/L
  1112.     As you can change all the features, individually and on the
  1113. fly, you can end up with a smorgasbord of defaults.
  1114.         This option toggles off and on whether the current
  1115. setting for certain key settings that affect program 
  1116. operation
  1117. are displayed when you press {Alt-S}. The display occurs at the
  1118. initial Scan & Clip menu. 
  1119.     This is a handy reminder and helps let you know whether the
  1120. current settings need to be changed for the intended operation.
  1121. However, if you have a slower chip, this feature involves an
  1122. initial delay (barely noticeable on faster chips), thus, you are
  1123. given the option to toggle it off.
  1124.     Note: because of FW3 rules, the settings will not display in
  1125. certain situations; e.g. if {alt-s} is invoked from a zoomed
  1126. formula.
  1127.     The original default for Display Key Settings is "Y"
  1128. (without the quotes).
  1129.     Change as explained in Section 4.3, above.
  1130. Display Key Settings 
  1131.     As you can change all the features, individually and on the
  1132. fly, you can end up with a smorgasbord of defaults.
  1133.     Especially if you have set your "permanent" defaults to fit
  1134. your usual document format, it is helpful to get back "home" to
  1135. your permanent defaults.
  1136.     Choosing this option resets all the above to their permanent
  1137. default, which may have been changed from their original
  1138. defaults. See Section 4.3, especially Sections 4.3.1.2 and 4.3.2.
  1139. 4.3.2.
  1140. All reset (set all to "permanent" defaults)
  1141. Reports
  1142.      After scanning is completed, the program produces a report 
  1143. formatted for printing.  The report, as generated, should be 
  1144. sufficient in the majority of circumstances, for printing
  1145. without  modification.  In addition, as elsewhere herein
  1146. explained, the Setup options for the program allow several of the
  1147. key report parameters to be toggled on and off and changed.
  1148.     In addition, on a case-by-case basis, the entire report can
  1149. be substantially modified after generated, by using the built-in
  1150. Framework word and printing options.
  1151. Although the generated report can be "final draft" quality,
  1152. the real intent is to generate a good "first draft" that can be
  1153. refined with FW3's other features
  1154. As generated
  1155.      Under the Setup sub-menu (See above), is a sub-menu for
  1156. setting and changing printing attributes.  These attributes can
  1157. be changed on a document by document basis, or permanently reset
  1158. as explained above.  Some of these options will be more further
  1159. discussed in the following subsections of this documentation.
  1160. Changing report options
  1161.      Once a report is generated, it is a Framework frame, a word 
  1162. document.  It can be modified in whole or in part manually, by 
  1163. using the normal Framework word processing and printing options.
  1164. Portions can be deleted and substantial additions can be made.
  1165. All or part can be moved to a larger document.  
  1166.      Thus, should you forget, for example, to properly set the 
  1167. page parameter calculations, the report can be checked against 
  1168. the actual hard copy document and the page cross references can 
  1169. be changed easily to be correct.
  1170. Modifying a generated report
  1171.     Scans of certain frames, especially complicated outlines,
  1172. may result in a reporting glitch. This is rare. 
  1173.     Rare as they are, the most common among the rare is a
  1174. multiple flag for a hit; e.g. three hit #7 flags before actually
  1175. showing the hit. In my experience, the hit count remains accurate
  1176. and these multiple flags simply need to be manually deleted.
  1177. Glitches
  1178.      The generated report is, itself, a document that can be 
  1179. scanned by the Scan & Clip program.  In some circumstances, you 
  1180. may want to further refine your report to limit the hits to those
  1181. that match in another search term. 
  1182.      To do this, simply 
  1183.  the 
  1184. generated report
  1185.  with the more 
  1186. limiting search criteria.
  1187.      For example, a deposition in a benzene case might have 
  1188. hundreds of references to "benzene" and you may decide you only 
  1189. want references to both "benzene" and "smoking" that appear in 
  1190. the same selected context block. To produce such a report, 
  1191. simply scan the original document on "benzene".  Then, scan the
  1192. generated report on "smoking".  
  1193.      Of course, a report produced this way will require cleaning 
  1194. up with the word processing functions of Framework and the hard
  1195. copy page references will be totally off and not correspond to
  1196. the original document. (simply fix with Framework's word
  1197. processing features)
  1198. Scanning a Scan & Clip generated report
  1199. Special topics
  1200.     The program was designed on a color VGA (graphics) and looks
  1201. good on it and my alternate color EGA (graphics) system and
  1202. laptop LCD (T1000SE). You may want to adjust color settings to
  1203. look good on your system. 
  1204.     I have not tried this program on a mono, character, screen.
  1205. Screen display
  1206. Although I have regularly and successfully scanned a wide
  1207. variety of frames, including complicated outlines, word frames,
  1208. formulas, databases, and spreadsheets, I also have run into some
  1209. glitches that I can only explain by machine configuration. For
  1210. an example, see the next Section.
  1211.     My only suggestion if that happens to you is to check your
  1212. Frame, Word, and Locate settings to see if they might explain
  1213. the problem. (e.g. did you miss a "hit" because {ctrl-l}, Ignore
  1214. Capitalization, was set to "off"?).
  1215.     I would appreciate a report of any glitches so I can
  1216. determine if it can be controlled or eliminated in subsequent
  1217. versions.
  1218. Scan or Clip or Report glitches and errors
  1219.     Because WHAT in an outline you may desire to scan may vary
  1220. from contents, labels, or formulas, the program must be
  1221. instructed on what to search for. This instruction can come from
  1222. user input at a prompt or by a default instruction. See Sections
  1223. 4.4.5 where this explained.
  1224. IMPORTANT NOTE: YOU CAN NOT SCAN & CLIP THE 
  1225. CONTENTS
  1226. DATABASES AND SPREADSHEETS 
  1227. IN AN OUTLINE.
  1228.     Complicated, multi-level outlines can be scanned (but you
  1229. can not scan the contents of databases and spreadsheets
  1230. contained in an outline). For examples, both the contents of
  1231. this documentation and the formulas contained in the nested
  1232. sub-frames of SCLprg were scanned. 
  1233.     For some applications, scanning an outline can be used as a
  1234. method of "batch" processing a scan & clip project.
  1235.     A report for an outline also varies : If the formula areas
  1236. are scanned, there will be a separate report for each sub-frame;
  1237. if contents or labels are searched, there will be one
  1238. consolidated report.
  1239. : Although I have regularly and successfully scanned a
  1240. wide variety of outlines for text, formulas, and labels, I also
  1241. have run into some glitches that I can only explain by machine
  1242. configuration. For example, if, 
  1243. on my laptop
  1244. , I scan this SCLDOC
  1245. outline frame on its labels, the scan completes, but the report
  1246. format is garbled and does not correspond to the source
  1247. document. But if I scan the same frame with the same version of
  1248. SCLprg on my desktop at work I have no problem. Strange. My only
  1249. suggestion if that happens to you is to check your Frame, Word,
  1250. and Locate settings to see if they might explain the problem.
  1251.     ERROR NOTE : Certain frame or sub-frame titles can cause
  1252. errors and scan to abort. E.g. Long frame names (over 160
  1253. characters). If this happens, simply rename and see if it helps.
  1254. Scanning Outlines
  1255.     Formula areas can be searched, either for an individual
  1256. frame or for all sub-frames in a containing frame. Initial
  1257. required cursor placement differs for each type of formula
  1258. search. See Section 3.2.2.
  1259.     This makes Scan & Clip a programming aid. E.g. search SCRprg
  1260. for all occurrences of the Global Variable HOMEG, in any
  1261. sub-frame. You can search a complicated program (with
  1262. sub-routines nested) as an outline [cursor on outer most frame
  1263. label, choose F when prompted for type of outline]. For example,
  1264. the many sub-frames of SCLprg were scanned on one pass.
  1265. Scanning Formulas
  1266.     Scan & Clip was written from a text perspective. Further,
  1267. the built-in FW3 filter features decrease its usefulness on
  1268. databases. Nevertheless, I included database and spreadsheet
  1269. modules AND have found some practical uses. 
  1270. Some examples
  1271.     DATABASE : Search the "Task" field of my time and billing
  1272. database (which can not be effectively filtered), to find every
  1273. time I talked to Mr. "X" on any file matter;
  1274.     SPREADSHEET : Search an amortization schedule to create a
  1275. report that shows the balance due as of May of every year, to
  1276. analyze the situation at each annual option to terminate under
  1277. the terms of a lease on the same property. 
  1278.     Databases should be searched in "table view", i.e.
  1279. row/column.
  1280.     Note : The report for a database or spreadsheet scan will
  1281. show the row number for each hit as it appears in the database
  1282. or spreadsheet, 
  1283. when scanned
  1284.     Also note: The original screen and printing default setting
  1285. probably will have to be changed for databases and spreadsheets,
  1286. which, typically, are wider than text or formula.
  1287. POTENTIAL SPECIAL PROBLEM
  1288.     Because of the manner in which FW3's search function works
  1289. in a database and spreadsheet, this version of Scan & Clip must
  1290. first copy the data to a temporary text file to search. This
  1291. created a special concern: A FW3 word frame can hold only a
  1292. limited number of characters. 
  1293. The source frame may exceed that
  1294. which the temporary frame can hold.
  1295.  The program senses such an
  1296. occurrence, so informs you and aborts. If this happens, your
  1297. source frame must be split (manually or by filtering) into
  1298. smaller parts, in order to Scan & Clip.
  1299. ALSO NOTE: THE CONTENTS OF DATABASES AND SPREADSHEETS CAN 
  1300. SEARCHED IN AN OUTLINE.
  1301. TLINE.
  1302. Scanning databases and spreadsheets
  1303.     The FW menu bar settings can be important and sometimes
  1304. explain (and fix) what at first appears to be a bug in the
  1305. program. For example, if you have Locate Ignore Capitalization
  1306. off, then your scan and clip will be sensitive to
  1307. capitalization. 
  1308.     This situation also is a desirable feature that allows you
  1309. to further customize a scan. Simply set the menu choices 
  1310. before
  1311. a particular scan. 
  1312.     Many of the FW3 menus can effect a scan and clip session.
  1313. The main ones are Locate, Frames, and Words.
  1314. The effect of 
  1315. Framework
  1316.  menu settings
  1317.     To avoid clutter and repetition, you may wish not to
  1318. duplicate "hits" that occur within some sub-range of the context
  1319. block that is captured on a prior "hit". 
  1320.     This is an option that can be selected from Setup and the
  1321. size of the range of excluded "hits" can be modified. See
  1322. Sections 4.4.2.3 and 4.4.2.4 above.
  1323. Eliminating close proximity hits
  1324.     Several documents can be scanned at once, as a batch. The
  1325. documents to be scanned can reside on the desktop or floppy or
  1326. hard disk.
  1327.     In addition to the batch options, a scan of an outline, in
  1328. some applications, can be used as a method of a batched scan &
  1329. clip project.
  1330.     See Section 3.2.2 on required cursor placement and Section
  1331. 4.4.4 on further batch options and instructions.
  1332. as a 
  1333. Batch Scans
  1334.     Under some circumstances setting the context capture block
  1335. to 0 (zero) can produce erroneous line report results
  1336. [WARNING] can corrupt the source document.
  1337.     If you set context capture to zero AND there are characters
  1338. in line one (1) of the source document, THEN the first character
  1339. of line one of the source frame will be deleted. I did NOT fix
  1340. this known bug, Because [1] this is a rare circumstance and
  1341. because [2] the fix would have complicated ripple effects and
  1342. because 
  1343. [3] without regard to this known bug, you should NEVER
  1344. save the 
  1345. source
  1346.  frame after a scan (if for no other reason than
  1347. to protect the source frame from some condition not encountered
  1348. by me)
  1349. I have deliberately left this bug in the program.
  1350. The work around is -- never save a source frame after a scan and,
  1351. if the line count is off, you can correct it with FW3's normal
  1352. word processing features.
  1353. Zero (0) capture context block
  1354.     Especially when scanning outlines, program execution is
  1355. heavily dependent on the @setselection command. In the wrong
  1356. combination of circumstances, this can cause the program to abort
  1357. with an error.
  1358.     Three of the most common:
  1359. 1. Frame or label not named. The program senses and corrects some
  1360. instances of this, but not all. If your program aborts, check to
  1361. see that the scanned frame and sub-frames all have 
  1362. discrete
  1363.  label
  1364. names;
  1365. 2. Frame or label name is too long (must be under 160
  1366. characters);
  1367. 3. "Current Mode" // I am not sure what this, but in "Current
  1368. Mode", @setselection can not be used to select or change frames.
  1369. This APPEARS to be related to low memory. Usually, re-running
  1370. after memory restoration solves the problem. Or the file(s) being
  1371. scanned may be too large, which sometimes can be solved by a disk
  1372. batch scan.
  1373.     Especi
  1374. "@setselection" errors
  1375.     Sometimes a scan will produce an error condition that will
  1376. not go away and affects frames that, before, scanned correctly.
  1377. To solve this either re-boot without saving sclprg or Library.
  1378. Persistent  "sudden" or unexpected errors
  1379.     The main option that increases speed (but at the sacrifice
  1380. of presentation) is either to toggle off the option to highlight
  1381. hits in a report or use the Quick method of highlighting, see
  1382. Sections 4.4.1.4.1 and 4.4.1.4.2.
  1383. Toggles that increase speed
  1384.     Page references are calculated. Especially if the relevant
  1385. calculation factors are not properly sensed or set, the page
  1386. calculations can be off. But, if everything is set properly for
  1387. the particular document to be scanned, I have found the page
  1388. references to be very accurate.
  1389.     See Section 4.4.3 for a complete explanation.
  1390.     Of course, if a few or all page cross references are off,
  1391. they can be proofread and changed in the report by using
  1392. Framework's word processing.
  1393. ssing.
  1394. Page references
  1395. SCLaarea
  1396. .dme - intro "readme" text file that directs
  1397.    you to read these instructions
  1398. SCLins
  1399. .fw3 - the auto install program
  1400. SCLms1
  1401. .fw3 - auto install pop-up instructions
  1402. SCLms2
  1403. .fw3 - basic instructions for a quick test run
  1404. SCLaltm
  1405. .fw3 - the invoking macro for your Library
  1406. SCLprg
  1407. .fw3 - the scan and clip program
  1408. SCLdoc
  1409. .FW3 - these instructions
  1410.     8  SCL
  1411. .fw3 - a sample file to scan for a trial run
  1412. Files Included With SCLip.ARC - All must be installed on
  1413. your FW3 default drive and path change to be accurate
  1414. be install
  1415. ; Scan & Clip  
  1416.     ; by Gary Reger
  1417.         ;VERSION 
  1418. 90-07-23
  1419. ;                    (c) copyright claimed
  1420. ;..........................................
  1421.     PLEASE REPORT ANY BUGS AND LET ME HAVE YOUR SUGGESTIONS,
  1422. Thanks,
  1423.              Gary Reger, CIS # 72416,3377.
  1424. Version information
  1425.